<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Icarous: /home/research133/Software/Icarous2/cFS/apps/geofence/fsw/src/geofence.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Icarous
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_c1698e121239b1aba7f6e782e4514e49.html">cFS</a></li><li class="navelem"><a class="el" href="dir_7ee4ce95da95d11e80a01c5101ed8d14.html">apps</a></li><li class="navelem"><a class="el" href="dir_c481d7fee0e22217fbf7acbe5704656a.html">geofence</a></li><li class="navelem"><a class="el" href="dir_63ac12da94c4ba7c4a85d1047d19ee5a.html">fsw</a></li><li class="navelem"><a class="el" href="dir_a8b7769090b2686553b561bd33dfe63d.html">src</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">geofence.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Definition of defines, structs and functions for geofence monitoring app.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;cfe.h&quot;</code><br />
<code>#include &quot;cfe_error.h&quot;</code><br />
<code>#include &quot;cfe_evs.h&quot;</code><br />
<code>#include &quot;cfe_sb.h&quot;</code><br />
<code>#include &quot;cfe_es.h&quot;</code><br />
<code>#include &lt;string.h&gt;</code><br />
<code>#include &quot;GeofenceMonitor_proxy.h&quot;</code><br />
<code>#include &quot;<a class="el" href="ardupilot__msgids_8h_source.html">msgids/ardupilot_msgids.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="ardupilot__msg_8h_source.html">msgdef/ardupilot_msg.h</a>&quot;</code><br />
<code>#include &quot;geofence_tbl.c&quot;</code><br />
<code>#include &quot;<a class="el" href="geofence__msg_8h_source.html">msgdef/geofence_msg.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="geofence__msgids_8h_source.html">msgids/geofence_msgids.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="scheduler__msgids_8h_source.html">msgids/scheduler_msgids.h</a>&quot;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for geofence.h:</div>
<div class="dyncontent">
<div class="center"><img src="geofence_8h__incl.png" border="0" usemap="#_2home_2research133_2Software_2Icarous2_2cFS_2apps_2geofence_2fsw_2src_2geofence_8h" alt=""/></div>
<map name="_2home_2research133_2Software_2Icarous2_2cFS_2apps_2geofence_2fsw_2src_2geofence_8h" id="_2home_2research133_2Software_2Icarous2_2cFS_2apps_2geofence_2fsw_2src_2geofence_8h">
<area shape="rect" id="node9" href="ardupilot__msgids_8h.html" title="Message ID definition of ardupilot app messages. " alt="" coords="1049,109,1226,136"/>
<area shape="rect" id="node10" href="ardupilot__msg_8h.html" title="Ardupilot message definitions. " alt="" coords="265,109,426,136"/>
<area shape="rect" id="node13" href="geofence__msg_8h.html" title="Defintion of messages used by geofence_msg.h. " alt="" coords="24,109,190,136"/>
<area shape="rect" id="node14" href="geofence__msgids_8h.html" title="Defines message topics published by the geofence application. " alt="" coords="1251,109,1432,136"/>
<area shape="rect" id="node15" href="scheduler__msgids_8h.html" title="message topics published by the scheduler " alt="" coords="1456,109,1640,136"/>
</map>
</div>
</div>
<p><a href="geofence_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structgeofenceAppData__t.html">geofenceAppData_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Struct to hold geofence app data.  <a href="structgeofenceAppData__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ae582eb8a9812575ac007bb737d83fffb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae582eb8a9812575ac007bb737d83fffb"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>GEOFENCE_STARTUP_INF_EID</b>&#160;&#160;&#160;0</td></tr>
<tr class="separator:ae582eb8a9812575ac007bb737d83fffb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a525d55c36c50484d765d0c0e0847521c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a525d55c36c50484d765d0c0e0847521c"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>GEOFENCE_COMMAND_ERR_EID</b>&#160;&#160;&#160;1</td></tr>
<tr class="separator:a525d55c36c50484d765d0c0e0847521c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac220f7e71f64dd48872a972c933b077f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac220f7e71f64dd48872a972c933b077f"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>GEOFENCE_RECEIVED_FENCE_EID</b>&#160;&#160;&#160;3</td></tr>
<tr class="separator:ac220f7e71f64dd48872a972c933b077f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acfa472ca9117eb7debc64e61ca0487c2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acfa472ca9117eb7debc64e61ca0487c2"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>GEOFENCE_PIPE_DEPTH</b>&#160;&#160;&#160;100</td></tr>
<tr class="separator:acfa472ca9117eb7debc64e61ca0487c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03c81a91ce4f48cede6344994eef2a1c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03c81a91ce4f48cede6344994eef2a1c"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>GEOFENCE_PIPE_NAME</b>&#160;&#160;&#160;&quot;GEOFENCE_PIPE&quot;</td></tr>
<tr class="separator:a03c81a91ce4f48cede6344994eef2a1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99821b4410649080129c7fe490893fc9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a99821b4410649080129c7fe490893fc9"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>GEOFENCE_MAJOR_VERSION</b>&#160;&#160;&#160;1</td></tr>
<tr class="separator:a99821b4410649080129c7fe490893fc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cb63d47e8ad7e0308f8640a9e45735b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7cb63d47e8ad7e0308f8640a9e45735b"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>GEOFENCE_MINOR_VERSION</b>&#160;&#160;&#160;0</td></tr>
<tr class="separator:a7cb63d47e8ad7e0308f8640a9e45735b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a382acb2e83857a0fdcd2c6be47e75c62"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="geofence_8h.html#a382acb2e83857a0fdcd2c6be47e75c62">GEOFENCE_AppMain</a> (void)</td></tr>
<tr class="separator:a382acb2e83857a0fdcd2c6be47e75c62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10d8d3896d07f8f93168abfe24c6c479"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="geofence_8h.html#a10d8d3896d07f8f93168abfe24c6c479">GEOFENCE_AppInit</a> (void)</td></tr>
<tr class="separator:a10d8d3896d07f8f93168abfe24c6c479"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7a3841f3ad129babc9d44478d6d3bded"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="geofence_8h.html#a7a3841f3ad129babc9d44478d6d3bded">GEOFENCE_AppCleanUp</a> ()</td></tr>
<tr class="separator:a7a3841f3ad129babc9d44478d6d3bded"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66ee93d2843f4655bc055a55d4702fe3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="geofence_8h.html#a66ee93d2843f4655bc055a55d4702fe3">GEOFENCE_ProcessPacket</a> ()</td></tr>
<tr class="separator:a66ee93d2843f4655bc055a55d4702fe3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a827dc2e94095ea54a3ff9ad61cfae7f6"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="geofence_8h.html#a827dc2e94095ea54a3ff9ad61cfae7f6">GeofenceTableValidationFunc</a> (void *TblPtr)</td></tr>
<tr class="separator:a827dc2e94095ea54a3ff9ad61cfae7f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a16edc578b0a42b1b5e39450f47f3e16f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a16edc578b0a42b1b5e39450f47f3e16f"></a>
<a class="el" href="structgeofenceAppData__t.html">geofenceAppData_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="geofence_8h.html#a16edc578b0a42b1b5e39450f47f3e16f">geofenceAppData</a></td></tr>
<tr class="memdesc:a16edc578b0a42b1b5e39450f47f3e16f"><td class="mdescLeft">&#160;</td><td class="mdescRight">global variable to hold app data <br /></td></tr>
<tr class="separator:a16edc578b0a42b1b5e39450f47f3e16f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Definition of defines, structs and functions for geofence monitoring app. </p>
<dl class="section author"><dt>Author</dt><dd>Swee Balachandran </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a7a3841f3ad129babc9d44478d6d3bded"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void GEOFENCE_AppCleanUp </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>App clean up </p>

</div>
</div>
<a class="anchor" id="a10d8d3896d07f8f93168abfe24c6c479"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void GEOFENCE_AppInit </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>App initialization </p>

</div>
</div>
<a class="anchor" id="a382acb2e83857a0fdcd2c6be47e75c62"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void GEOFENCE_AppMain </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>App's main entry point </p>

</div>
</div>
<a class="anchor" id="a66ee93d2843f4655bc055a55d4702fe3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void GEOFENCE_ProcessPacket </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Function to process received packets </p>

</div>
</div>
<a class="anchor" id="a827dc2e94095ea54a3ff9ad61cfae7f6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int32_t GeofenceTableValidationFunc </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>TblPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Function to validate table parameters </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">TblPtr</td><td>pointer to table </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if success </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
